<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit - Firmware API: appled.c Source File</title>
<link href="mt_doxygen.css" rel="stylesheet" type="text/css" />
<link href="../resources/mt_doxytabs.css" rel="stylesheet" type="text/css" />
<style type="text/css">
<!--
.header {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 12pt;
	color: #222222;
}
-->
</style>
</head>

<body>
<table width="800" border="0">
    <tr>
      <td colspan="3">
        <form method="get" action="http://www.google.com/search">
          <div align="right">
            <input type="text"   name="q" size="25"
              maxlength="255" value="" />
            <input type="submit" value="Search" />
            <input type="hidden" name="sitesearch" value="makingthings.com/ref/firmware/html" />
          </div>
        </form>
       </td>
    </tr>
    <tr>
      <td><div align="center"><a href="http://www.makingthings.com">
				<img src="../resources/logo_brown_medium.png" alt="MakingThings"
									width="200" height="78" border="0" align="middle" longdesc="http://www.makingthings.com" /></a></div></td>
				<td><div align="center" class="header">
      		Make Controller Kit <br />
          Firmware API
      </div></td>
      <td><div align="center"><a href="http://www.makezine.com">
					<img src="../resources/make_logo.png" alt="MAKE Zine" 
										width="164" height="73" border="0" align="middle" longdesc="http://www.makezine.com" /></a></div></td>
    </tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.5.4 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
  var num=this.id.replace(/[^[0-9]/g,'');
  var button=this.firstChild;
  var sectionDiv=document.getElementById('dynsection'+num);
  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
    sectionDiv.style.display='block';
    button.src='open.gif';
  }else{
    sectionDiv.style.display='none';
    button.src='closed.gif';
  }
}
function initDynSections(){
  var divs=document.getElementsByTagName('div');
  var sectionCounter=1;
  for(var i=0;i<divs.length-1;i++){
    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
      var header=divs[i];
      var section=divs[i+1];
      var button=header.firstChild;
      if (button!='IMG'){
        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
        button=document.createElement('img');
        divs[i].insertBefore(button,divs[i].firstChild);
      }
      header.style.cursor='pointer';
      header.onclick=changeDisplayState;
      header.id='dynheader'+sectionCounter;
      button.src='closed.gif';
      section.id='dynsection'+sectionCounter;
      section.style.display='none';
      section.style.marginLeft='14px';
      sectionCounter++;
    }
  }
}
window.onload = initDynSections;
-->
</script>
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>appled.c</h1><a href="appled_8c.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*********************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> Copyright 2006 MakingThings</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> Licensed under the Apache License, </span>
<a name="l00006"></a>00006 <span class="comment"> Version 2.0 (the "License"); you may not use this file except in compliance </span>
<a name="l00007"></a>00007 <span class="comment"> with the License. You may obtain a copy of the License at</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> http://www.apache.org/licenses/LICENSE-2.0 </span>
<a name="l00010"></a>00010 <span class="comment"> </span>
<a name="l00011"></a>00011 <span class="comment"> Unless required by applicable law or agreed to in writing, software distributed</span>
<a name="l00012"></a>00012 <span class="comment"> under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR</span>
<a name="l00013"></a>00013 <span class="comment"> CONDITIONS OF ANY KIND, either express or implied. See the License for</span>
<a name="l00014"></a>00014 <span class="comment"> the specific language governing permissions and limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">*********************************************************************************/</span>
<a name="l00017"></a>00017 
<a name="l00018"></a>00018 <span class="comment">// MakingThings - Make Controller Kit - 2006</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">/** \file appled.c  </span>
<a name="l00021"></a>00021 <span class="comment">  MAKE Application Board LED control.</span>
<a name="l00022"></a>00022 <span class="comment">  Library of functions for the Make Application Board's LED subsystem.</span>
<a name="l00023"></a>00023 <span class="comment">*/</span>
<a name="l00024"></a>00024 
<a name="l00025"></a>00025 <span class="preprocessor">#include "io.h"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "appled.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "config.h"</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#include "AT91SAM7X256.h"</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="preprocessor">#define APPLED_COUNT 4 </span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#if ( APPBOARD_VERSION == 50 )</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">  #define APPLED_0_IO IO_PB19</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">  #define APPLED_1_IO IO_PB20</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">  #define APPLED_2_IO IO_PB21</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">  #define APPLED_3_IO IO_PB22</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#if ( APPBOARD_VERSION == 90 )</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">  #define APPLED_0_IO IO_PA10</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">  #define APPLED_1_IO IO_PA11</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">  #define APPLED_2_IO IO_PA13</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">  #define APPLED_3_IO IO_PA15</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#if ( APPBOARD_VERSION == 95 || APPBOARD_VERSION == 100 )</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">  #define APPLED_0_IO IO_PA15</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">  #define APPLED_1_IO IO_PA13</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">  #define APPLED_2_IO IO_PA28</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">  #define APPLED_3_IO IO_PA27</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span>
<a name="l00052"></a>00052 <span class="keyword">static</span> <span class="keywordtype">int</span> AppLed_GetIo( <span class="keywordtype">int</span> index );
<a name="l00053"></a>00053 <span class="keyword">static</span> <span class="keywordtype">int</span> AppLed_Start( <span class="keywordtype">int</span> index );
<a name="l00054"></a>00054 <span class="keyword">static</span> <span class="keywordtype">int</span> AppLed_Stop( <span class="keywordtype">int</span> index );
<a name="l00055"></a>00055 
<a name="l00056"></a>00056 <span class="keyword">static</span> <span class="keywordtype">int</span> AppLed_users[ APPLED_COUNT ];
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment">/** \defgroup AppLed Application Board LEDs</span>
<a name="l00059"></a>00059 <span class="comment">* The Application Board LED subsystem controls the 4 LEDs on the Application Board, for status and program feedback.</span>
<a name="l00060"></a>00060 <span class="comment">* \ingroup AppBoard</span>
<a name="l00061"></a>00061 <span class="comment">* @{</span>
<a name="l00062"></a>00062 <span class="comment">*/</span>
<a name="l00063"></a>00063 <span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment">/**</span>
<a name="l00065"></a>00065 <span class="comment">  Attempts to gain access to the I/O lines associated the given LED.</span>
<a name="l00066"></a>00066 <span class="comment">  @param index An integer specifying which LED (0-3).</span>
<a name="l00067"></a>00067 <span class="comment">  @param state An integer specifying locked/active (1) or unlocked/inactive (0).</span>
<a name="l00068"></a>00068 <span class="comment">  @return Zero on success.</span>
<a name="l00069"></a>00069 <span class="comment">*/</span>
<a name="l00070"></a><a class="code" href="group___app_led.html#gd0ee0aad03c0aa89b442bf75e073510d">00070</a> <span class="keywordtype">int</span> <a class="code" href="group___app_led.html#gd0ee0aad03c0aa89b442bf75e073510d" title="Attempts to gain access to the I/O lines associated the given LED.">AppLed_SetActive</a>( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> state )
<a name="l00071"></a>00071 {
<a name="l00072"></a>00072   <span class="keywordflow">if</span> ( index &lt; 0 || index &gt;= APPLED_COUNT )
<a name="l00073"></a>00073     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g097f40c958abccd892d08f31b53c4dde" title="The requested index is not valid.">CONTROLLER_ERROR_ILLEGAL_INDEX</a>;
<a name="l00074"></a>00074 
<a name="l00075"></a>00075   <span class="keywordflow">if</span> ( state )
<a name="l00076"></a>00076     <span class="keywordflow">return</span> AppLed_Start( index );
<a name="l00077"></a>00077   <span class="keywordflow">else</span>
<a name="l00078"></a>00078     <span class="keywordflow">return</span> AppLed_Stop( index );
<a name="l00079"></a>00079 }
<a name="l00080"></a>00080 <span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment">/**</span>
<a name="l00082"></a>00082 <span class="comment">  Returns whether the I/O lines associated with the LED are available.</span>
<a name="l00083"></a>00083 <span class="comment">  @param index An integer specifying which LED (0-3).</span>
<a name="l00084"></a>00084 <span class="comment">  @return Zero if available, otherwise non-zero.</span>
<a name="l00085"></a>00085 <span class="comment">*/</span>
<a name="l00086"></a><a class="code" href="group___app_led.html#g7733e566f4a851f1d04ca41635e8a309">00086</a> <span class="keywordtype">int</span> <a class="code" href="group___app_led.html#g7733e566f4a851f1d04ca41635e8a309" title="Returns whether the I/O lines associated with the LED are available.">AppLed_GetActive</a>( <span class="keywordtype">int</span> index )
<a name="l00087"></a>00087 {
<a name="l00088"></a>00088   <span class="keywordflow">if</span> ( index &lt; 0 || index &gt;= APPLED_COUNT )
<a name="l00089"></a>00089     <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00090"></a>00090   <span class="keywordflow">return</span> AppLed_users[ index ] &gt; 0;
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment">/** </span>
<a name="l00094"></a>00094 <span class="comment">  Control an LED on the Application Board.</span>
<a name="l00095"></a>00095 <span class="comment">  Sets whether the specified LED on the Application Board is on or off.</span>
<a name="l00096"></a>00096 <span class="comment">  @param index an integer specifying which LED (0-3).</span>
<a name="l00097"></a>00097 <span class="comment">  @param state an integer specifying on (1) or off (0).</span>
<a name="l00098"></a>00098 <span class="comment">  @return Zero on success, otherwise error code.</span>
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="comment">  \par Example</span>
<a name="l00101"></a>00101 <span class="comment">  \code</span>
<a name="l00102"></a>00102 <span class="comment">  // turn on LED 2</span>
<a name="l00103"></a>00103 <span class="comment">  AppLed_SetState( 2, 1 );</span>
<a name="l00104"></a>00104 <span class="comment">  \endcode</span>
<a name="l00105"></a>00105 <span class="comment">*/</span>
<a name="l00106"></a><a class="code" href="group___app_led.html#gdf0cd1ff241ad17592b9036b674613cc">00106</a> <span class="keywordtype">int</span> <a class="code" href="group___app_led.html#gdf0cd1ff241ad17592b9036b674613cc" title="Control an LED on the Application Board.">AppLed_SetState</a>( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> state )
<a name="l00107"></a>00107 {
<a name="l00108"></a>00108   <span class="keywordflow">if</span> ( index &lt; 0 || index &gt;= APPLED_COUNT )
<a name="l00109"></a>00109     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g097f40c958abccd892d08f31b53c4dde" title="The requested index is not valid.">CONTROLLER_ERROR_ILLEGAL_INDEX</a>;
<a name="l00110"></a>00110 
<a name="l00111"></a>00111   <span class="keywordflow">if</span> ( AppLed_users[ index ] &lt; 1 )
<a name="l00112"></a>00112   {
<a name="l00113"></a>00113     <span class="keywordtype">int</span> status = AppLed_Start( index );
<a name="l00114"></a>00114     <span class="keywordflow">if</span> ( status != <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a> )
<a name="l00115"></a>00115       <span class="keywordflow">return</span> status;
<a name="l00116"></a>00116   }
<a name="l00117"></a>00117 
<a name="l00118"></a>00118   <span class="keywordtype">int</span> io = AppLed_GetIo( index );
<a name="l00119"></a>00119   <span class="comment">// remember the LED's are tied to +3.3, so they're</span>
<a name="l00120"></a>00120   <span class="comment">// on when the output is off</span>
<a name="l00121"></a>00121   <span class="keywordflow">if</span> ( state )
<a name="l00122"></a>00122     Io_SetFalse( io );
<a name="l00123"></a>00123   <span class="keywordflow">else</span> 
<a name="l00124"></a>00124     Io_SetTrue( io );
<a name="l00125"></a>00125 
<a name="l00126"></a>00126   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00127"></a>00127 }
<a name="l00128"></a>00128 <span class="comment"></span>
<a name="l00129"></a>00129 <span class="comment">/** </span>
<a name="l00130"></a>00130 <span class="comment">  Read the state of an LED on the Application Board.</span>
<a name="l00131"></a>00131 <span class="comment">  @param index An integer specifying which LED (0-3).</span>
<a name="l00132"></a>00132 <span class="comment">  @return the LED state, or zero on error.</span>
<a name="l00133"></a>00133 <span class="comment">*/</span>
<a name="l00134"></a><a class="code" href="group___app_led.html#g8f5aa2a42d5eb1cf6c39a933c9a5baca">00134</a> <span class="keywordtype">int</span> <a class="code" href="group___app_led.html#g8f5aa2a42d5eb1cf6c39a933c9a5baca" title="Read the state of an LED on the Application Board.">AppLed_GetState</a>( <span class="keywordtype">int</span> index )
<a name="l00135"></a>00135 {
<a name="l00136"></a>00136   <span class="keywordflow">if</span> ( index &lt; 0 || index &gt;= APPLED_COUNT )
<a name="l00137"></a>00137     <span class="keywordflow">return</span> 0;
<a name="l00138"></a>00138 
<a name="l00139"></a>00139   <span class="keywordflow">if</span> ( AppLed_users[ index ] &lt; 1 )
<a name="l00140"></a>00140   {
<a name="l00141"></a>00141     <span class="keywordtype">int</span> status = AppLed_Start( index );
<a name="l00142"></a>00142     <span class="keywordflow">if</span> ( status != <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a> )
<a name="l00143"></a>00143       <span class="keywordflow">return</span> status;
<a name="l00144"></a>00144   }
<a name="l00145"></a>00145 
<a name="l00146"></a>00146   <span class="keywordtype">int</span> io = AppLed_GetIo( index );
<a name="l00147"></a>00147   <span class="keywordflow">return</span> <a class="code" href="group___io.html#gfdcf7332d0ae5b38d2a776fb6cc5ba7b" title="Read whether an IO line, presumably set as an output, is on or off.">Io_GetValue</a>( io ) ? 0 : 1;
<a name="l00148"></a>00148 }
<a name="l00149"></a>00149 <span class="comment"></span>
<a name="l00150"></a>00150 <span class="comment">/** @}</span>
<a name="l00151"></a>00151 <span class="comment">*/</span>
<a name="l00152"></a>00152 
<a name="l00153"></a>00153 <span class="keywordtype">int</span> AppLed_Start( <span class="keywordtype">int</span> index )
<a name="l00154"></a>00154 {
<a name="l00155"></a>00155   <span class="keywordtype">int</span> status;
<a name="l00156"></a>00156 
<a name="l00157"></a>00157   <span class="keywordflow">if</span> ( AppLed_users[ index ]++ == 0 )
<a name="l00158"></a>00158   {
<a name="l00159"></a>00159     <span class="keywordtype">int</span> io = AppLed_GetIo( index );
<a name="l00160"></a>00160 
<a name="l00161"></a>00161     status = Io_Start( io, <span class="keyword">true</span> );
<a name="l00162"></a>00162     <span class="keywordflow">if</span> ( status != <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a> )
<a name="l00163"></a>00163     {
<a name="l00164"></a>00164       AppLed_users[ index ]--;
<a name="l00165"></a>00165       <span class="keywordflow">return</span> <a class="code" href="group___error.html#g5317aab1608afa7507da0214aec0dbab" title="Can&amp;#39;t get a lock on a resource.">CONTROLLER_ERROR_CANT_LOCK</a>;
<a name="l00166"></a>00166     }
<a name="l00167"></a>00167 
<a name="l00168"></a>00168     <span class="comment">// Got it, now set the io up right</span>
<a name="l00169"></a>00169     Io_PioEnable( io );
<a name="l00170"></a>00170     Io_SetTrue( io );
<a name="l00171"></a>00171     Io_SetOutput( io );
<a name="l00172"></a>00172   }
<a name="l00173"></a>00173 
<a name="l00174"></a>00174   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00175"></a>00175 }
<a name="l00176"></a>00176 
<a name="l00177"></a>00177 <span class="keywordtype">int</span> AppLed_Stop( <span class="keywordtype">int</span> index )
<a name="l00178"></a>00178 {
<a name="l00179"></a>00179   <span class="keywordflow">if</span> ( AppLed_users[ index ] &lt; 1 )
<a name="l00180"></a>00180     <span class="keywordflow">return</span> <a class="code" href="group___error.html#gbe5b0c7c2a59668cdeb433375f091c2a" title="This resource has already been stopped too many times.">CONTROLLER_ERROR_TOO_MANY_STOPS</a>;
<a name="l00181"></a>00181 
<a name="l00182"></a>00182   <span class="keywordflow">if</span> ( --AppLed_users[ index ] == 0 )
<a name="l00183"></a>00183   {
<a name="l00184"></a>00184     <span class="keywordtype">int</span> io = AppLed_GetIo( index );
<a name="l00185"></a>00185     Io_Stop( io );
<a name="l00186"></a>00186   }
<a name="l00187"></a>00187   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00188"></a>00188 }
<a name="l00189"></a>00189 
<a name="l00190"></a>00190 <span class="keywordtype">int</span> AppLed_GetIo( <span class="keywordtype">int</span> index )
<a name="l00191"></a>00191 {
<a name="l00192"></a>00192   <span class="keywordtype">int</span> io = -1;
<a name="l00193"></a>00193   <span class="keywordflow">switch</span> ( index )
<a name="l00194"></a>00194   {
<a name="l00195"></a>00195     <span class="keywordflow">case</span> 0:
<a name="l00196"></a>00196       io = APPLED_0_IO;
<a name="l00197"></a>00197       <span class="keywordflow">break</span>;
<a name="l00198"></a>00198     <span class="keywordflow">case</span> 1:
<a name="l00199"></a>00199       io = APPLED_1_IO;
<a name="l00200"></a>00200       <span class="keywordflow">break</span>;
<a name="l00201"></a>00201     <span class="keywordflow">case</span> 2:
<a name="l00202"></a>00202       io = APPLED_2_IO;
<a name="l00203"></a>00203       <span class="keywordflow">break</span>;
<a name="l00204"></a>00204     <span class="keywordflow">case</span> 3:
<a name="l00205"></a>00205       io = APPLED_3_IO;
<a name="l00206"></a>00206       <span class="keywordflow">break</span>;
<a name="l00207"></a>00207   }
<a name="l00208"></a>00208   <span class="keywordflow">return</span> io;
<a name="l00209"></a>00209 }
<a name="l00210"></a>00210 
<a name="l00211"></a>00211 <span class="preprocessor">#ifdef OSC</span>
<a name="l00212"></a>00212 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00213"></a>00213 <span class="comment">/** \defgroup AppLEDOSC App LED - OSC</span>
<a name="l00214"></a>00214 <span class="comment">  Control the Application Board's Status LEDs via OSC.</span>
<a name="l00215"></a>00215 <span class="comment">  \ingroup OSC</span>
<a name="l00216"></a>00216 <span class="comment">  </span>
<a name="l00217"></a>00217 <span class="comment">  \section devices Devices</span>
<a name="l00218"></a>00218 <span class="comment">  There are 4 LEDs on the Make Application Board, numbered 0 - 3.</span>
<a name="l00219"></a>00219 <span class="comment">  </span>
<a name="l00220"></a>00220 <span class="comment">  \section properties Properties</span>
<a name="l00221"></a>00221 <span class="comment">  The LEDs have two properties:</span>
<a name="l00222"></a>00222 <span class="comment">  - state</span>
<a name="l00223"></a>00223 <span class="comment">  - active</span>
<a name="l00224"></a>00224 <span class="comment"></span>
<a name="l00225"></a>00225 <span class="comment">  \par State</span>
<a name="l00226"></a>00226 <span class="comment">  The \b state property corresponds to the on/off state of a given LED.</span>
<a name="l00227"></a>00227 <span class="comment">  For example, to turn on the first LED, send a message like</span>
<a name="l00228"></a>00228 <span class="comment">  \verbatim /appled/0/state 1\endverbatim</span>
<a name="l00229"></a>00229 <span class="comment">  To turn it off, send the message \verbatim /appled/0/state 0\endverbatim</span>
<a name="l00230"></a>00230 <span class="comment">  </span>
<a name="l00231"></a>00231 <span class="comment">  \par Active</span>
<a name="l00232"></a>00232 <span class="comment">  The \b active property corresponds to the active state of an LED.</span>
<a name="l00233"></a>00233 <span class="comment">  If an LED is set to be active, no other tasks will be able to</span>
<a name="l00234"></a>00234 <span class="comment">  write to it.  If you're not seeing appropriate</span>
<a name="l00235"></a>00235 <span class="comment">  responses to your messages to the LED, check the whether it's </span>
<a name="l00236"></a>00236 <span class="comment">  locked by sending a message like</span>
<a name="l00237"></a>00237 <span class="comment">  \verbatim /appled/0/active \endverbatim</span>
<a name="l00238"></a>00238 <span class="comment">  \par</span>
<a name="l00239"></a>00239 <span class="comment">  You can set the active flag by sending</span>
<a name="l00240"></a>00240 <span class="comment">  \verbatim /appled/0/active 1 \endverbatim</span>
<a name="l00241"></a>00241 <span class="comment">*/</span>
<a name="l00242"></a>00242 
<a name="l00243"></a>00243 <span class="preprocessor">#include "osc.h"</span>
<a name="l00244"></a>00244 <span class="preprocessor">#include "string.h"</span>
<a name="l00245"></a>00245 <span class="preprocessor">#include "stdio.h"</span>
<a name="l00246"></a>00246 
<a name="l00247"></a>00247 <span class="comment">// Need a list of property names</span>
<a name="l00248"></a>00248 <span class="comment">// MUST end in zero</span>
<a name="l00249"></a>00249 <span class="keyword">static</span> <span class="keywordtype">char</span>* AppLedOsc_Name = <span class="stringliteral">"appled"</span>;
<a name="l00250"></a>00250 <span class="keyword">static</span> <span class="keywordtype">char</span>* AppLedOsc_PropertyNames[] = { <span class="stringliteral">"active"</span>, <span class="stringliteral">"state"</span>, 0 }; <span class="comment">// must have a trailing 0</span>
<a name="l00251"></a>00251 
<a name="l00252"></a>00252 <span class="keywordtype">int</span> AppLedOsc_PropertySet( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> property, <span class="keywordtype">int</span> value );
<a name="l00253"></a>00253 <span class="keywordtype">int</span> AppLedOsc_PropertyGet( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> property );
<a name="l00254"></a>00254 
<a name="l00255"></a>00255 <span class="comment">// Returns the name of the subsystem</span>
<a name="l00256"></a>00256 <span class="keyword">const</span> <span class="keywordtype">char</span>* AppLedOsc_GetName( )
<a name="l00257"></a>00257 {
<a name="l00258"></a>00258   <span class="keywordflow">return</span> AppLedOsc_Name;
<a name="l00259"></a>00259 }
<a name="l00260"></a>00260 
<a name="l00261"></a>00261 <span class="comment">// Now getting a message.  This is actually a part message, with the first</span>
<a name="l00262"></a>00262 <span class="comment">// part (the subsystem) already parsed off.</span>
<a name="l00263"></a>00263 <span class="keywordtype">int</span> AppLedOsc_ReceiveMessage( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length )
<a name="l00264"></a>00264 {
<a name="l00265"></a>00265   <span class="keywordtype">int</span> status = <a class="code" href="group___o_s_c_a_p_i.html#gdaa5a3868eeedcf785c3d52f6b36ef34" title="Receive integers for a subsystem with multiple indexes.">Osc_IndexIntReceiverHelper</a>( channel, message, length, 
<a name="l00266"></a>00266                                            APPLED_COUNT, AppLedOsc_Name,
<a name="l00267"></a>00267                                            AppLedOsc_PropertySet, AppLedOsc_PropertyGet, 
<a name="l00268"></a>00268                                            AppLedOsc_PropertyNames );
<a name="l00269"></a>00269 
<a name="l00270"></a>00270   <span class="keywordflow">if</span> ( status != <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a> )
<a name="l00271"></a>00271     <span class="keywordflow">return</span> Osc_SendError( channel, AppLedOsc_Name, status );
<a name="l00272"></a>00272   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00273"></a>00273 }
<a name="l00274"></a>00274 
<a name="l00275"></a>00275 <span class="comment">// Set the index LED, property with the value</span>
<a name="l00276"></a>00276 <span class="keywordtype">int</span> AppLedOsc_PropertySet( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> property, <span class="keywordtype">int</span> value )
<a name="l00277"></a>00277 {
<a name="l00278"></a>00278   <span class="keywordflow">switch</span> ( property )
<a name="l00279"></a>00279   {
<a name="l00280"></a>00280     <span class="keywordflow">case</span> 0: 
<a name="l00281"></a>00281       <a class="code" href="group___app_led.html#gd0ee0aad03c0aa89b442bf75e073510d" title="Attempts to gain access to the I/O lines associated the given LED.">AppLed_SetActive</a>( index, value );
<a name="l00282"></a>00282       <span class="keywordflow">break</span>;      
<a name="l00283"></a>00283     <span class="keywordflow">case</span> 1:
<a name="l00284"></a>00284       <a class="code" href="group___app_led.html#gdf0cd1ff241ad17592b9036b674613cc" title="Control an LED on the Application Board.">AppLed_SetState</a>( index, value );
<a name="l00285"></a>00285       <span class="keywordflow">break</span>;
<a name="l00286"></a>00286   }
<a name="l00287"></a>00287   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00288"></a>00288 }
<a name="l00289"></a>00289 
<a name="l00290"></a>00290 <span class="comment">// Get the index LED, property</span>
<a name="l00291"></a>00291 <span class="keywordtype">int</span> AppLedOsc_PropertyGet( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> property )
<a name="l00292"></a>00292 {
<a name="l00293"></a>00293   <span class="keywordtype">int</span> value = 0;
<a name="l00294"></a>00294   <span class="keywordflow">switch</span> ( property )
<a name="l00295"></a>00295   {
<a name="l00296"></a>00296     <span class="keywordflow">case</span> 0:
<a name="l00297"></a>00297       value = <a class="code" href="group___app_led.html#g7733e566f4a851f1d04ca41635e8a309" title="Returns whether the I/O lines associated with the LED are available.">AppLed_GetActive</a>( index );
<a name="l00298"></a>00298       <span class="keywordflow">break</span>;
<a name="l00299"></a>00299     <span class="keywordflow">case</span> 1:
<a name="l00300"></a>00300       value = <a class="code" href="group___app_led.html#g8f5aa2a42d5eb1cf6c39a933c9a5baca" title="Read the state of an LED on the Application Board.">AppLed_GetState</a>( index );
<a name="l00301"></a>00301       <span class="keywordflow">break</span>;
<a name="l00302"></a>00302   }
<a name="l00303"></a>00303   
<a name="l00304"></a>00304   <span class="keywordflow">return</span> value;
<a name="l00305"></a>00305 }
<a name="l00306"></a>00306 
<a name="l00307"></a>00307 <span class="preprocessor">#endif</span>
</pre></div><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit</title>
<style type="text/css">
<!--
.footer {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 9pt;
	color: #999999;
}
-->
</style>
</head>

<body>
<hr size="1">
<div>
  <p class="footer">The Make Controller Kit is an open source project maintained by <a href="http://www.makingthings.com">MakingThings</a>.<br />
    MakingThings code is released under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html" target="_blank">Apache 2.0 license</a>.<br />
    Bug tracker, development wiki and status can be found at <a href="http://dev.makingthings.com">http://dev.makingthings.com</a>.<br />
		This document was last updated on 5 Dec 2007.
</p>
</div>
<!-- Google Analytics Code -->
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-769030-1";
urchinTracker();
</script>
</body>
</html>
